GET api/delegategroups/{delegateGroupId}/clientsgroup?includeExpired={includeExpired}&offset={offset}&count={count}&searchTerm={searchTerm}&searchColumns[0]={searchColumns[0]}&searchColumns[1]={searchColumns[1]}&userDefinedFields[0]={userDefinedFields[0]}&userDefinedFields[1]={userDefinedFields[1]}

Gets the delegate client group information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
delegateGroupId

The delegate group to get clients for.

 integer

Required
includeExpired

When set to true, clients with an expiry date in the past will be included as well.

 boolean

Default value is False
offset

The offset to the first result to return

 integer

Default value is 0
count

The maximum number of results to return

 integer

Default value is 25
searchTerm

A string to use to filter the results (searches first/last name, client id, client code)

 string

Default value is

searchColumns

List of columns to be search for provided criteria

 Collection of string

None.
userDefinedFields

List of user defind fields to fetch for client info data

 Collection of string

None.

Body Parameters

None.

Response Information

Resource Description

Returns basic information about the clients in the group.

Collection of DelegateClientGroupInfo
NameDescriptionTypeAdditional information
ClientCount

Gets or sets the total client count in delegate group

 integer

None.
FilteredResultCount

Gets or sets the no. of client count when filtered

 integer

None.
Clients

Gets or sets the client list received as a part of group info.

 Collection of DelegateClientInfo

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "clientCount": 1,
    "filteredResultCount": 2,
    "clients": [
      {
        "clientId": 1,
        "clientCode": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "birthDate": "2024-12-23",
        "startDate": "2024-12-23T12:17:50.2803422-07:00",
        "expiryDate": "2024-12-23T12:17:50.2803422-07:00",
        "dynamicallyAdded": true,
        "phoneNumber": "sample string 6",
        "userDefinedFields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "clientId": 1,
        "clientCode": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "birthDate": "2024-12-23",
        "startDate": "2024-12-23T12:17:50.2803422-07:00",
        "expiryDate": "2024-12-23T12:17:50.2803422-07:00",
        "dynamicallyAdded": true,
        "phoneNumber": "sample string 6",
        "userDefinedFields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ]
  },
  {
    "clientCount": 1,
    "filteredResultCount": 2,
    "clients": [
      {
        "clientId": 1,
        "clientCode": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "birthDate": "2024-12-23",
        "startDate": "2024-12-23T12:17:50.2803422-07:00",
        "expiryDate": "2024-12-23T12:17:50.2803422-07:00",
        "dynamicallyAdded": true,
        "phoneNumber": "sample string 6",
        "userDefinedFields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "clientId": 1,
        "clientCode": "sample string 2",
        "firstName": "sample string 3",
        "lastName": "sample string 4",
        "birthDate": "2024-12-23",
        "startDate": "2024-12-23T12:17:50.2803422-07:00",
        "expiryDate": "2024-12-23T12:17:50.2803422-07:00",
        "dynamicallyAdded": true,
        "phoneNumber": "sample string 6",
        "userDefinedFields": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDelegateClientGroupInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources">
  <DelegateClientGroupInfo>
    <ClientCount>1</ClientCount>
    <Clients xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
      <d3p1:DelegateClientInfo>
        <d3p1:BirthDate>2024-12-23T12:17:50.2803422-07:00</d3p1:BirthDate>
        <d3p1:ClientCode>sample string 2</d3p1:ClientCode>
        <d3p1:ClientId>1</d3p1:ClientId>
        <d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
        <d3p1:ExpiryDate>2024-12-23T12:17:50.2803422-07:00</d3p1:ExpiryDate>
        <d3p1:FirstName>sample string 3</d3p1:FirstName>
        <d3p1:LastName>sample string 4</d3p1:LastName>
        <d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
        <d3p1:StartDate>2024-12-23T12:17:50.2803422-07:00</d3p1:StartDate>
        <d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d3p1:UserDefinedFields>
      </d3p1:DelegateClientInfo>
      <d3p1:DelegateClientInfo>
        <d3p1:BirthDate>2024-12-23T12:17:50.2803422-07:00</d3p1:BirthDate>
        <d3p1:ClientCode>sample string 2</d3p1:ClientCode>
        <d3p1:ClientId>1</d3p1:ClientId>
        <d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
        <d3p1:ExpiryDate>2024-12-23T12:17:50.2803422-07:00</d3p1:ExpiryDate>
        <d3p1:FirstName>sample string 3</d3p1:FirstName>
        <d3p1:LastName>sample string 4</d3p1:LastName>
        <d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
        <d3p1:StartDate>2024-12-23T12:17:50.2803422-07:00</d3p1:StartDate>
        <d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d3p1:UserDefinedFields>
      </d3p1:DelegateClientInfo>
    </Clients>
    <FilteredResultCount>2</FilteredResultCount>
  </DelegateClientGroupInfo>
  <DelegateClientGroupInfo>
    <ClientCount>1</ClientCount>
    <Clients xmlns:d3p1="http://schemas.datacontract.org/2004/07/TS.DR.Resources.Delegates">
      <d3p1:DelegateClientInfo>
        <d3p1:BirthDate>2024-12-23T12:17:50.2803422-07:00</d3p1:BirthDate>
        <d3p1:ClientCode>sample string 2</d3p1:ClientCode>
        <d3p1:ClientId>1</d3p1:ClientId>
        <d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
        <d3p1:ExpiryDate>2024-12-23T12:17:50.2803422-07:00</d3p1:ExpiryDate>
        <d3p1:FirstName>sample string 3</d3p1:FirstName>
        <d3p1:LastName>sample string 4</d3p1:LastName>
        <d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
        <d3p1:StartDate>2024-12-23T12:17:50.2803422-07:00</d3p1:StartDate>
        <d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d3p1:UserDefinedFields>
      </d3p1:DelegateClientInfo>
      <d3p1:DelegateClientInfo>
        <d3p1:BirthDate>2024-12-23T12:17:50.2803422-07:00</d3p1:BirthDate>
        <d3p1:ClientCode>sample string 2</d3p1:ClientCode>
        <d3p1:ClientId>1</d3p1:ClientId>
        <d3p1:DynamicallyAdded>true</d3p1:DynamicallyAdded>
        <d3p1:ExpiryDate>2024-12-23T12:17:50.2803422-07:00</d3p1:ExpiryDate>
        <d3p1:FirstName>sample string 3</d3p1:FirstName>
        <d3p1:LastName>sample string 4</d3p1:LastName>
        <d3p1:PhoneNumber>sample string 6</d3p1:PhoneNumber>
        <d3p1:StartDate>2024-12-23T12:17:50.2803422-07:00</d3p1:StartDate>
        <d3p1:UserDefinedFields xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d3p1:UserDefinedFields>
      </d3p1:DelegateClientInfo>
    </Clients>
    <FilteredResultCount>2</FilteredResultCount>
  </DelegateClientGroupInfo>
</ArrayOfDelegateClientGroupInfo>